﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class DiceTerm
   | RogueSharp </title>
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <meta name="title" content="Class DiceTerm
   - RogueSharp ">
    <meta name="generator" content="docfx 2.47.0.0">
    
    <link rel="shortcut icon" href="../images/favicon.ico">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/css/bootstrap.min.css" integrity="sha384-9gVQ4dYFwwWSjIDZnLEWnxCjeSWFphJiwGPXr1jddIhOegiu1FwO5qRGvFXOdJZ4" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/dracula.min.css">
    <link rel="stylesheet" href="../styles/site.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="bg-light">
        <nav class="navbar navbar-expand-lg navbar-light bg-light container">
          
          <a class="navbar-brand" href="../index.html">
            <img id="logo" class="svg" src="../images/logo.svg" alt="RogueSharp" width="36" height="36">
          </a>
          <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
            <span class="navbar-toggler-icon"></span>
          </button>
        
          <div class="collapse navbar-collapse" id="navbar">
            <!--<form id="search" role="search" class="form-inline my-2 my-lg-0">
              <input id="search-query" class="form-control mr-sm-2" type="search" placeholder="Search" autocomplete="off" aria-label="Search">
            </form>-->
          </div>
        </nav>
        </div>
        
        <div class="bg-dark">
        <nav aria-label="breadcrumb" id="breadcrumb" class="container hide-when-search">
          <!--<ol class="breadcrumb">
            <li class="breadcrumb-item" aria-current="page"></li>
          </ol>-->
        </nav>
        </div>      </header>
      <div role="main" class="container body-content hide-when-search">
      <div class="row">
        
        
        <div class="sidenav hide-when-search col-md-3 pt-md-3 pb-md-3">
          <a class="btn btn-link toc-toggle d-md-none" data-toggle="collapse" data-target="#sidetoggle" href="javascript:;" aria-expanded="true" aria-controls="sidetoggle">
            Show / Hide Table of Contents
          </a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article col-md-9">
      <div class="row">
          <div class="col-lg-9">
            <article class="content wrap pt-2 pb-2" id="_content" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm">
  
  
  <h1 id="RogueSharp_DiceNotation_Terms_DiceTerm" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm" class="text-break">Class DiceTerm
  </h1>
  <div class="markdown level0 summary"><p>The DiceTerm class represents a single &quot;d&quot; term in a DiceExpression</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance mt-1">
    <h5 class="text-muted font-weight-light font-italic mb-0">Inheritance</h5>
    <div class="d-flex flex-wrap">
    <div class="level0 mr-1"><span class="xref">System.Object</span><i class="fal fa-arrow-alt-left fa-fw"></i></div>
    <div class="level1"><span class="xref">DiceTerm</span></div>
    </div>
  </div>
  <div class="implements mt-1">
    <h5 class="font-weight-light font-italic mb-0">
      <a class="text-muted" data-toggle="collapse" data-target="#implementsCollapse" role="button" aria-expanded="false" aria-controls="implementsCollapse">
      Implements
      </a>
    </h5>
    <div class="collapse" id="implementsCollapse">
    <div><a class="xref" href="RogueSharp.DiceNotation.Terms.IDiceExpressionTerm.html">IDiceExpressionTerm</a></div>
    </div>
  </div>
  <div class="inheritedMembers mt-1">
    <h5 class="font-weight-light font-italic mb-0">
      <a class="text-muted" data-toggle="collapse" data-target="#inheritedMembersCollapse" role="button" aria-expanded="false" aria-controls="inheritedMembersCollapse">
      Inherited Members
      </a>
    </h5>
    <div class="collapse" id="inheritedMembersCollapse">
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    </div>
  </div>
  <h6 class="mt-1"><i class="text-muted font-weight-light font-italic mb-0">Namespace:</i> <a class="xref" href="RogueSharp.DiceNotation.Terms.html">RogueSharp.DiceNotation.Terms</a></h6>
  <h6 class="mt-1"><i class="text-muted font-weight-light font-italic mb-0">Assembly:</i> RogueSharp.dll</h6>
  <h5 id="RogueSharp_DiceNotation_Terms_DiceTerm_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class DiceTerm : IDiceExpressionTerm</code></pre>
  </div>
  <h5 id="RogueSharp_DiceNotation_Terms_DiceTerm_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>In the expression &quot;2d6+5&quot; the term &quot;2d6&quot; is a DiceTerm</p>
</div>
  <h3 id="constructors">Constructors
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm__ctor_System_Int32_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.%23ctor(System.Int32%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L42">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm__ctor_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.#ctor*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm__ctor_System_Int32_System_Int32_System_Int32_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.#ctor(System.Int32,System.Int32,System.Int32)">DiceTerm(Int32, Int32, Int32)</h4>
  <div class="markdown level1 summary"><p>Construct a new instance of the DiceTerm class using the specified values</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public DiceTerm(int multiplicity, int sides, int scalar)</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">multiplicity</span></td>
        <td><p>The number of dice</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">sides</span></td>
        <td><p>The number of sides per die</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">scalar</span></td>
        <td><p>The amount to multiply the final sum of the dice by</p>
</td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm__ctor_System_Int32_System_Int32_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.%23ctor(System.Int32%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L53">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm__ctor_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.#ctor*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm__ctor_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">DiceTerm(Int32, Int32, Int32, Int32)</h4>
  <div class="markdown level1 summary"><p>Construct a new instance of the DiceTerm class using the specified values</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public DiceTerm(int multiplicity, int sides, int choose, int scalar)</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">multiplicity</span></td>
        <td><p>The number of dice</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">sides</span></td>
        <td><p>The number of sides per die</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">choose</span></td>
        <td><p>Sum this many dice with the highest values out of those rolled</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">scalar</span></td>
        <td><p>The amount to multiply the final sum of the dice by</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_Choose.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.Choose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L34">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_Choose_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Choose*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_Choose" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Choose">Choose</h4>
  <div class="markdown level1 summary"><p>Sum this many dice with the highest values out of those rolled</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected int Choose { get; }</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_Multiplicity.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.Multiplicity%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L19">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_Multiplicity_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Multiplicity*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_Multiplicity" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Multiplicity">Multiplicity</h4>
  <div class="markdown level1 summary"><p>The number of dice</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int Multiplicity { get; }</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_Scalar.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.Scalar%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L29">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_Scalar_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Scalar*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_Scalar" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Scalar">Scalar</h4>
  <div class="markdown level1 summary"><p>The amount to multiply the final sum of the dice by</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int Scalar { get; }</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_Sides.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.Sides%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L24">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_Sides_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Sides*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_Sides" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.Sides">Sides</h4>
  <div class="markdown level1 summary"><p>The number of sides per die</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int Sides { get; }</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_GetResults.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.GetResults%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L101">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_GetResults_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.GetResults*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_GetResults" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.GetResults">GetResults()</h4>
  <div class="markdown level1 summary"><p>Gets the TermResult for this DiceTerm which will include the random value rolled</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IEnumerable&lt;TermResult&gt; GetResults()</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="RogueSharp.DiceNotation.TermResult.html">TermResult</a>&gt;</td>
        <td><p>An IEnumerable of TermResult which will have one item per die rolled</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="RogueSharp_DiceNotation_Terms_DiceTerm_GetResults_remarks" class="text-muted font-weight-light font-italic">Remarks</h5>
  <div class="markdown level1 remarks"><p>Uses DotNetRandom as its RNG</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_GetResults_RogueSharp_Random_IRandom_.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.GetResults(RogueSharp.Random.IRandom)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L83">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_GetResults_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.GetResults*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_GetResults_RogueSharp_Random_IRandom_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.GetResults(RogueSharp.Random.IRandom)">GetResults(IRandom)</h4>
  <div class="markdown level1 summary"><p>Gets the TermResult for this DiceTerm which will include the random value rolled</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IEnumerable&lt;TermResult&gt; GetResults(IRandom random)</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="RogueSharp.Random.IRandom.html">IRandom</a></td>
        <td><span class="parametername">random</span></td>
        <td><p>IRandom RNG used to perform the Roll.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="text-muted font-weight-light font-italic returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="RogueSharp.DiceNotation.TermResult.html">TermResult</a>&gt;</td>
        <td><p>An IEnumerable of TermResult which will have one item per die rolled</p>
</td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm_ToString.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L110">View Source</a>
  </span>
  <a id="RogueSharp_DiceNotation_Terms_DiceTerm_ToString_" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.ToString*"></a>
  <h4 id="RogueSharp_DiceNotation_Terms_DiceTerm_ToString" data-uid="RogueSharp.DiceNotation.Terms.DiceTerm.ToString">ToString()</h4>
  <div class="markdown level1 summary"><p>Returns a string that represents this DiceTerm</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="text-muted font-weight-light font-italic decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  </div>
  <h5 class="text-muted font-weight-light font-italic returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><p>A string representing this DiceTerm</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="text-muted font-weight-light font-italic overrides">Overrides</h5>
  <div><span class="xref">System.Object.ToString()</span></div>
  <h3 id="implements" class="text-muted font-weight-light font-italic">Implements</h3>
  <div>
      <a class="xref" href="RogueSharp.DiceNotation.Terms.IDiceExpressionTerm.html">IDiceExpressionTerm</a>
  </div>
</article>
            <div id="disqus_thread"></div>
            <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
          </div>
          
          <div class="d-none d-lg-block col-md-3" role="complementary">
            <div class="sideaffix pt-3 pb-3">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/FaronBracy/RogueSharp/new/master/apiSpec/new?filename=RogueSharp_DiceNotation_Terms_DiceTerm.md&amp;value=---%0Auid%3A%20RogueSharp.DiceNotation.Terms.DiceTerm%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link text-info" title="Improve this Doc">
                    <i class="fal fa-edit fa-fw"></i>
                    <span>Improve this Doc</span>
                    </a>
                  </li>
                  <li>
                    <a href="https://github.com/FaronBracy/RogueSharp/blob/master/RogueSharp/DiceNotation/Terms/DiceTerm.cs/#L14" class="contribution-link text-info" title="View Source">
                    <i class="fal fa-code fa-fw"></i>
                    <span>View Source</span>
                    </a>
                  </li>
                </ul>
              </div>
              <!--<div class="github-links">
                  <a class="github-button" href="https://github.com/fszlin/certes" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star fszlin/certes on GitHub">Star</a>
              </div>-->
              <nav class="hidden-print affix mt-2" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
          </div>
        </div>
      </div>
      </div>
      
      <footer class="bg-secondary">
        <!--<div class="grad-bottom"></div>-->
        <div class="footer bg-secondary">
          <div class="container">
          <div class="d-flex">
            <div class="p-2 flex-grow-1 text-white">
            <a class="text-white" href="https://github.com/FaronBracy/RogueSharp">RogueSharp &copy; 2014-2020 Faron Bracy</a>
            
            </div>
            <div class="p-2">
              <a class="text-white" href="#top">Back to top</a>
            </div>
          </div>
          </div>
        </div>
      </footer>
    </div>
    
    <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.0/umd/popper.min.js" integrity="sha384-cs/chFZiN24E4KMATLdqdvsezGxaGsi4hLGOzlXwp5UZB1LY//20VyM2taTB4QvJ" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/js/bootstrap.min.js" integrity="sha384-uefMccjFJAIv6A+rW+L4AHf99KvxDjWSu1z9VI8SKNVmz4sk7buKt/6v9KI65qnm" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/dos.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/powershell.min.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
  </body>
</html>
